Skip to content

Align logging to match cargo's style #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 3, 2025
Merged

Conversation

TimJentzsch
Copy link
Collaborator

@TimJentzsch TimJentzsch commented May 3, 2025

Objective

Closes #360.

Where possible, we should provide a familiar experience to users, matching what they are used to from cargo.
Our log message format currently looks quite different.

Solution

Use a custom formatter for tracing logging.

  • Use lower-case log levels with a colon
  • Adjust log messages to start with a lowercase letter, similar to what cargo does

Preview of the new log format

Future Work

Some of our messages are part of the build process and will be adjusted to look closer to the Finished messages cargo generates. See #362.

@TimJentzsch TimJentzsch added A-CLI Related to the main CLI and not a more specific subcommand D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Review The PR needs to be reviewed before it can be merged labels May 3, 2025
@TimJentzsch TimJentzsch requested review from DaAlbrecht and BD103 and removed request for DaAlbrecht May 3, 2025 11:12
Copy link
Collaborator

@DaAlbrecht DaAlbrecht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@TimJentzsch TimJentzsch merged commit 4898e0e into main May 3, 2025
10 checks passed
@TimJentzsch TimJentzsch deleted the 360-align-logging-to-cargo branch May 3, 2025 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-CLI Related to the main CLI and not a more specific subcommand D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Review The PR needs to be reviewed before it can be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Align logging design to look more similar to cargo
2 participants